home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / fortran / fordoc.com / USER.DOC < prev   
Encoding:
Text File  |  1991-02-11  |  8.8 KB  |  219 lines
  1.  
  2.  
  3.  
  4.                        (C) Copyright Ken Tucker 1991
  5.  
  6.                              WHAT IS FORDOC ?
  7.                              ----------------
  8.  
  9.           FORDOC is an integrated set of programs to extract the names
  10.           of symbols from FORTRAN source code and produce symbol tables
  11.           suitable for inclusion in program documentation.  One symbol
  12.           table is produced for each FORTRAN module( PROGRAM,
  13.           SUBROUTINE, or FUNCTION).
  14.  
  15.           The symbol tables identify local variables, variables in
  16.           common (blank and labeled), external references, and other
  17.           modules that call the target module.  Common extensions to
  18.           ANSI FORTRAN 77 are accepted; therefore, the FORTRAN source
  19.           code may be from PC's, minicomputers, or mainframes.  The
  20.           names of common FORTRAN math library routines are excluded from
  21.           the symbol table.
  22.  
  23.           FORDOC is intended to help FORTRAN programmers document their
  24.           source code.  FORDOC runs on IBM-compatible PC's running
  25.           MS-DOS or PC-DOS.  FORDOC will run on XT's, AT's, and PS2's.
  26.  
  27.           See the file READ.ME for information on becoming a registered
  28.           user of FORDOC and information on other products available.
  29.  
  30.  
  31.                             HOW TO USE FORDOC
  32.                             -----------------
  33.  
  34.           INSTALLATION
  35.           ------------
  36.  
  37.           The FORDOC distribution disk contains:
  38.                               FORDOC.EXE
  39.                               FORDOC2.EXE
  40.                               FORDOC3.EXE
  41.                               USER.DOC
  42.                               DEMO.RPT
  43.                               READ.ME
  44.  
  45.           The programs are not copy-protected.  To install FORDOC, copy
  46.           the contents of the distribution disk to a directory on your
  47.           working disk.
  48.  
  49.           For example:
  50.                         rem create a directory on the working disk
  51.                         MD C:\FORDOC
  52.                         rem copy the FORDOC files to the working disk
  53.                         COPY A:\*.* C:\FORDOC
  54.  
  55.          FORDOC.EXE starts building the symbol table(s); it executes
  56.          FORDOC2.EXE and FORDOC3.EXE.  USER.DOC contains the user
  57.          document that you are now reading.  DEMO.RPT contains a sample
  58.          symbol table.  READ.ME contains ordering information and
  59.          information on other products available.
  60.  
  61.  
  62.  
  63.          OPERATION
  64.          ---------
  65.  
  66.           If you are using DOS 3.0 or higher, you can use a full
  67.           pathname to execute the FORDOC programs.  If you are using a
  68.           version of DOS prior to 3.0, you should place the FORDOC
  69.           directory on your PATH.
  70.  
  71.           The following examples assume that you are using DOS 3.0 and
  72.           that FORDOC is installed in directory C:\FORDOC.  Further, it
  73.           is assumed that the FORTRAN source code is in directory
  74.           C:\FSOURCE and that the symbol tables are to be placed in
  75.           C:\FSOURCE\SYMBOLS.
  76.  
  77.           To create symbol tables for each of the modules in C:\FSOURCE,
  78.           use the following commands:
  79.  
  80.                             CD C:\FSOURCE\SYMBOLS
  81.                             C:\FORDOC\FORDOC C:\FSOURCE\*.FOR
  82.  
  83.           That's all there is to it.  FORDOC will create a symbol table
  84.           report file (modulename.RPT) for each of the FORTRAN modules
  85.           in C:\FSOURCE.  The symbol table report files will be created
  86.           in the current working directory (C:\FSOURCE\SYMBOLS).  The
  87.           .RPT files may be incorporated into comments in the source
  88.           code and/or included in documentation.
  89.  
  90.           Alternatively, FORDOC can be commanded to examine only one
  91.           FORTRAN source file:
  92.  
  93.                         CD C:\FSOURCE\SYMBOLS
  94.                         C:\FORDOC\FORDOC C:\FSOURCE\modulename.for
  95.  
  96.           In this case, FORDOC will only examine the source in the
  97.           modulename.FOR file; however, all other symbol tables in the
  98.           current working directory will be updated with current
  99.           information as to which module calls which other module.
  100.  
  101.  
  102.                                 FORDOC DETAILS
  103.                                 --------------
  104.  
  105.           DEFAULTS AND LIMITS
  106.           -------------------
  107.  
  108.           1.  Symbols may be up to 31 characters long.  Symbols longer
  109.               than 31 characters will be truncated.
  110.  
  111.           2.  Include files may be nested up to 30 levels deep.
  112.  
  113.           3.  The maximum number of symbols for any module is limited
  114.               by the amount of available memory.  With 450KB of
  115.               available memory, over 6000 unique symbols per module can
  116.               be handled.
  117.  
  118.  
  119.  
  120.           4.  Default lengths (in bytes) for types of variables are:
  121.                  REAL      4
  122.                  INTEGER   4
  123.                  CHARACTER 1
  124.                  LOGICAL   4
  125.                  COMPLEX   8
  126.               The default lengths may be changed with command-line
  127.               switches.
  128.  
  129.  
  130.           COMMAND-LINE SWITCHES
  131.           ---------------------
  132.  
  133.           If any command-line switches are used, they must be placed on
  134.           the command line before the .FOR argument.  For example:
  135.  
  136.                     C:\FORDOC\FORDOC /N C:\FSOURCE\*.FOR
  137.  
  138.           Command-line switches may not be combined:
  139.  
  140.                     C:\FORDOC\FORDOC /N /R8 C:\FSOURCE\*.FOR
  141.                                   (correct)
  142.                     C:\FORDOC\FORDOC /NR8 C:\FSOURCE\*.FOR
  143.                                  (incorrect)
  144.  
  145.           The command-line switches and their meanings are:
  146.  
  147.                      /N     Do not place a 'C' at the beginning of each
  148.                             line in the symbol table report.
  149.  
  150.                      /Rn    Use n as the default length for REAL
  151.                             variable type.
  152.  
  153.                      /In    Use n as the default length for INTEGER
  154.                             variable type.
  155.  
  156.                      /Cn    Use n as the default length for CHARACTER
  157.                             variable type.
  158.  
  159.                      /Ln    Use n as the default length for LOGICAL
  160.                             variable type.
  161.  
  162.                      /Xn    Use n as the default length for COMPLEX
  163.                             variable type.
  164.  
  165.           To make the default length for COMPLEX variables 8 bytes and
  166.           the default length for INTEGER 2 bytes, the following command
  167.           would be used:
  168.  
  169.                     C:\FORDOC\FORDOC /X8 /I2 C:\FSOURCE\*.FOR
  170.  
  171.              (C) Copyright Ken Tucker 1991
  172.  
  173.          ----------------end-of-author's-documentation---------------
  174.  
  175.                          Software Library Information:
  176.  
  177.                     This disk copy provided as a service of
  178.  
  179.                            Public (software) Library
  180.  
  181.          We are not the authors of this program, nor are we associated
  182.          with the author in any way other than as a distributor of the
  183.          program in accordance with the author's terms of distribution.
  184.  
  185.          Please direct shareware payments and specific questions about
  186.          this program to the author of the program, whose name appears
  187.          elsewhere in  this documentation. If you have trouble getting
  188.          in touch with the author,  we will do whatever we can to help
  189.          you with your questions. All programs have been tested and do
  190.          run.  To report problems,  please use the form that is in the
  191.          file PROBLEM.DOC on many of our disks or in other written for-
  192.          mat with screen printouts, if possible.  PsL cannot debug pro-
  193.          programs over the telephone, though we can answer questions.
  194.  
  195.          Disks in the PsL are updated  monthly,  so if you did not get
  196.          this disk directly from the PsL, you should be aware that the
  197.          files in this set may no longer be the current versions. Also,
  198.          if you got this disk from another vendor and are having prob-
  199.          lems,  be aware that  some files may have become corrupted or
  200.          lost by that vendor. Get a current, working disk from PsL.
  201.  
  202.          For a copy of the latest monthly software library newsletter
  203.          and a list of the 3,000+ disks in the library, call or write
  204.  
  205.                            Public (software) Library
  206.                                P.O.Box 35705 - F
  207.                             Houston, TX 77235-5705
  208.  
  209.                                 1-800-2424-PSL
  210.                              MC/Visa/AmEx/Discover
  211.  
  212.                           Outside of U.S. or in Texas
  213.                           or for general information,
  214.                               Call 1-713-524-6394
  215.  
  216.                           PsL also has an outstanding
  217.                           catalog for the Macintosh.
  218.  
  219.